Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve setup experience with example values & readme tips #33

Merged
merged 1 commit into from
Aug 29, 2023

Conversation

Andrew-Dickinson
Copy link
Member

This is just a workflow/readme PR that makes it easier to get started with the project. I find even when working with experienced developers, having comprehensive & unambiguous setup instructions dramatically decreases the burden when onboarding new folks

I made a guess about the DB_NAME value, but I'm guessing it doesn't matter as long as everyone reads from the same .env file. Roast me if it needs to be something specific

Copy link
Collaborator

@andybaumgar andybaumgar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Instructions work etc.

@Andrew-Dickinson
Copy link
Member Author

@WillNilges this is going to conflict with your readme changes in #27. Do you want me to wait and fix the conflicts on my side or are you okay if I merge now?

@WillNilges
Copy link
Collaborator

go for it

Copy link
Collaborator

@WillNilges WillNilges left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@Andrew-Dickinson Andrew-Dickinson merged commit a1e2f04 into main Aug 29, 2023
1 check passed
@Andrew-Dickinson Andrew-Dickinson deleted the readme-env-instructions branch July 27, 2024 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants